Skip to content

Conversation

@kaloudis
Copy link
Contributor

Description

Adds support for testnet4 to Embedded LND nodes. Will soon add support for testnet4 remote nodes.

This pull request is categorized as a:

  • New feature
  • Bug fix
  • Code refactor
  • Configuration change
  • Locales update
  • Quality assurance
  • Other

Checklist

  • I’ve run yarn run tsc and made sure my code compiles correctly
  • I’ve run yarn run lint and made sure my code didn’t contain any problematic patterns
  • I’ve run yarn run prettier and made sure my code is formatted correctly
  • I’ve run yarn run test and made sure all of the tests pass

Testing

If you modified or added a utility file, did you add new unit tests?

  • No, I’m a fool
  • Yes
  • N/A

I have tested this PR on the following platforms (please specify OS version and phone model/VM):

  • Android
  • iOS

I have tested this PR with the following types of nodes (please specify node version and API version where appropriate):

  • Embedded LND
  • LND (REST)
  • LND (Lightning Node Connect)
  • Core Lightning (CLNRest)
  • Nostr Wallet Connect
  • LndHub

Locales

  • I’ve added new locale text that requires translations
  • I’m aware that new translations should be made on the ZEUS Transfix page and not directly to this repo

Third Party Dependencies and Packages

  • Contributors will need to run yarn after this PR is merged in
  • 3rd party dependencies have been modified:
    • verify that package.json and yarn.lock have been properly updated
    • verify that dependencies are installed for both iOS and Android platforms

Other:

  • Changes were made that require an update to the README
  • Changes were made that require an update to onboarding

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @kaloudis, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly enhances the Embedded LND node functionality by adding full support for Testnet4. It provides users with greater control over their node's blockchain interaction through a new dedicated settings screen for selecting between Neutrino and Esplora backends. The changes ensure that the application correctly identifies, configures, and displays information for Testnet4, laying the groundwork for future remote node support.

Highlights

  • Testnet4 Support: Introduced comprehensive support for Testnet4 across the application, including network identification, UI display, and backend configurations for Embedded LND nodes.
  • Blockchain Backend Configuration: Added a new settings screen (BlockchainBackend.tsx) allowing users to choose between Neutrino and Esplora as the blockchain backend for embedded LND, with network-specific settings for each.
  • Dynamic Network Handling: Refactored core LND utility functions (writeLndConfig, initializeLnd, optimizeNeutrinoPeers, createLndWallet) to use a generic network string parameter, enabling more flexible and specific network configurations (Mainnet, Testnet3, Testnet4).
  • Esplora Integration: Integrated Esplora as an alternative blockchain backend, allowing users to select default or custom Esplora URLs for Mainnet, Testnet, and Testnet4.
  • Neutrino Peer Management: Updated Neutrino peer management to include specific default peer lists and configuration for Testnet4, ensuring correct peer selection and optimization.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request adds support for testnet4 to Embedded LND nodes. The changes are generally good, but I've identified some areas for code improvement, including refactoring for better readability and fixing inconsistencies in how network settings are handled, especially regarding network type checks. Please review the detailed comments for specific suggestions.

Comment on lines 385 to 382
export const EMBEDDED_NODE_NETWORK_KEYS = [
{ key: 'Mainnet', translateKey: 'network.mainnet', value: 'mainnet' },
{ key: 'Testnet', translateKey: 'network.testnet', value: 'testnet' }
{ key: 'Testnet3', translateKey: 'network.testnet3', value: 'testnet' },
{ key: 'Testnet4', translateKey: 'network.testnet4', value: 'testnet4' }
];
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

high

There seems to be an inconsistency in how embeddedLndNetwork is used across the codebase. This constant defines the internal values as mainnet, testnet, and testnet4. However, some parts of the code are checking for Testnet3 or testnet3 (e.g., stores/AlertStore.ts, views/Settings/EmbeddedNode/LNDLogs.tsx, utils/LndMobileUtils.ts). This can lead to bugs where conditions are not met as expected. Please ensure consistent use of the internal values (mainnet, testnet, testnet4) throughout the application.

References
  1. This rule clarifies the expected string value for 'Mainnet' when checking the network type from settingsStore.embeddedLndNetwork and emphasizes consistency in network naming and checks across the codebase.

Comment on lines 41 to 51
@computed public get isTestNet(): boolean {
return (
this.testnet ||
this.network === 'testnet' ||
this.network === 'testnet4' ||
(this.chains &&
this.chains[0] &&
this.chains[0].network === 'testnet')
(this.chains[0].network === 'testnet' ||
this.chains[0].network === 'testnet4'))
);
}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The logic for isTestNet can be simplified for better readability and to reduce redundancy, especially now that isTestNet4 is available.

Suggested change
@computed public get isTestNet(): boolean {
return (
this.testnet ||
this.network === 'testnet' ||
this.network === 'testnet4' ||
(this.chains &&
this.chains[0] &&
this.chains[0].network === 'testnet')
(this.chains[0].network === 'testnet' ||
this.chains[0].network === 'testnet4'))
);
}
@computed public get isTestNet(): boolean {
const networks = ['testnet', 'testnet4'];
return (
this.testnet ||
(this.network && networks.includes(this.network)) ||
(this.chains &&
this.chains[0] &&
this.chains[0].network &&
networks.includes(this.chains[0].network))
);
}

Comment on lines +392 to +395
export const getNetworkDisplayName = (network: string): string => {
const networkDisplayMap: { [key: string]: string } = {
mainnet: 'Mainnet',
Mainnet: 'Mainnet',
testnet: 'Testnet3',
Testnet3: 'Testnet3',
testnet4: 'Testnet4',
Testnet4: 'Testnet4'
};
return networkDisplayMap[network] || network;
};
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The networkDisplayMap contains redundant entries for capitalized and lowercased keys. You can simplify this function by converting the input network string to lowercase before the lookup. This will make the map more concise and easier to maintain.

export const getNetworkDisplayName = (network: string): string => {
    const lowercasedNetwork = network.toLowerCase();
    const networkDisplayMap: { [key: string]: string } = {
        mainnet: 'Mainnet',
        testnet: 'Testnet3',
        testnet4: 'Testnet4'
    };
    return networkDisplayMap[lowercasedNetwork] || network;
};

compactDb?: boolean;
}) => {
const isMainnet = !network || network === 'mainnet';
const isTestnet = network === 'testnet' || network === 'testnet3';
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The check network === 'testnet3' will always be false because the network value for Testnet3 is 'testnet'. This is confusing and should be removed to avoid potential bugs.

    const isTestnet = network === 'testnet';
References
  1. This rule clarifies the expected string value for 'Mainnet' when checking the network type from settingsStore.embeddedLndNetwork and emphasizes consistency in network naming and checks across the codebase.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant